Skip to content

Add dedicated page to explain endpointing#103

Open
Karamouche wants to merge 2 commits intomainfrom
feat/endpointing-doc
Open

Add dedicated page to explain endpointing#103
Karamouche wants to merge 2 commits intomainfrom
feat/endpointing-doc

Conversation

@Karamouche
Copy link
Contributor

@Karamouche Karamouche commented Jan 28, 2026 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Endpointing docs for Live Transcription: how silence-based utterance closing works, tradeoffs between latency and completeness, safety max-duration to prevent endless utterances, and configurable parameters (defaults and suggested ranges).
  • New Features
    • Added an Endpointing card and navigation entry in the Live Transcription features UI for quick access to the new docs.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 28, 2026 •
edited
Loading

📝 Walkthrough

Walkthrough

Adds a new documentation page and navigation entry for the Endpointing feature in Live STT, documenting silence-based utterance boundaries, two configuration parameters (endpointing, maximum_duration_without_endpointing), and UI-accessible speech activity events.

Changes

Cohort / File(s) Summary
Endpointing documentation
chapters/live-stt/features/endpointing.mdx		 New page describing endpointing behavior, workflow (SAD → utterance grouping → close on silence), parameter specs (endpointing: default 0.05s, range 0.01–10; maximum_duration_without_endpointing: default 5s, range 5–60), tradeoffs, and speech activity event notes.
Features index UI card
chapters/live-stt/features/index.mdx		 Added an "Endpointing" card to the Live STT features CardGroup linking to the new page.
Docs navigation
docs.json		 Inserted new Live Transcription navigation entry for chapters/live-stt/features/endpointing.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • mfernandez-gladia
  • nmorel

Poem

🐰 I twitch my nose at silence sweet,
I mark the pause where phrases meet.
When hush arrives, an utterance ends—
I hop away, then listen again. 🎧🌿

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding a new documentation page dedicated to explaining the endpointing feature.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/endpointing-doc

Tip

🧪 Unit Test Generation v2 is now available!

We have significantly improved our unit test generation capabilities.

To enable: Add this to your .coderabbit.yaml configuration:

reviews:
  finishing_touches:
    unit_tests:
      enabled: true

Try it out by using the @coderabbitai generate unit tests command on your code files or under ✨ Finishing Touches on the walkthrough!

Have feedback? Share your thoughts on our Discord thread!

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot]
coderabbitai bot reviewed Jan 28, 2026
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents 
In `@chapters/live-stt/features/endpointing.mdx`:
- Line 3: Update the frontmatter "description" value to correct the grammar:
change the string "What's endpointing and how it works" to a clearer form such
as "What endpointing is and how it works" (or "What endpointing is, and how it
works") by editing the description key in the file's frontmatter.
🧹 Nitpick comments (1)
chapters/live-stt/features/endpointing.mdx (1)

28-28: Link speech-activity messages to their callback docs.

This makes the “speech starts/ends” reference actionable for readers.

🔗 Suggested edit 
-You can also subscribe to speech activity messages to know when speech starts and ends (useful to drive UI or agent turn-taking)
+You can also subscribe to [`speech_start`](/api-reference/v2/live/callback/speech-start) and [`speech_end`](/api-reference/v2/live/callback/speech-end) messages to know when speech starts and ends (useful to drive UI or agent turn-taking).

remilejeune2
remilejeune2 requested changes Jan 29, 2026
View reviewed changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@remilejeune2 remilejeune2 remilejeune2 requested changes

@mfernandez-gladia mfernandez-gladia Awaiting requested review from mfernandez-gladia

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Karamouche @remilejeune2